home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / c / codecn.com / C-CNT.DOC next >
Encoding:
Text File  |  1990-01-31  |  21.2 KB  |  661 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                       C O D E   C O U N T   F O R   ' C '
  15.  
  16.           A Code Analysis and Documentation Tool For 'C' Programmers
  17.  
  18.                                   Version 1.0
  19.  
  20.                               January 1990 Release
  21.  
  22.                                   USERS MANUAL
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                               Enterprise Software
  46.                               7654 Quail Run Lane
  47.                                Manassas, VA 22110
  48.  
  49.                                  (703) 335-2781
  50.  
  51.                            Compuserve ID #   71041,3714
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.          Copyright (C) 1990 Enterprise Software.  All rights reserved.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                         Code Count For 'C' - Version 1.0
  70.  
  71.  
  72.  
  73.                                TABLE OF CONTENTS
  74.  
  75.  
  76.  
  77.          1.  Introduction: ....................................... 1
  78.          1.1 What is Code Count.  ................................ 1
  79.          2.  The Shareware Concept: .............................. 2
  80.          2.1 Why Register Code Count ?  .......................... 2
  81.          2.2 License. ............................................ 3
  82.          2.3 Warranty. ........................................... 3
  83.          2.4 Registration. ....................................... 3
  84.          3.  Code Count Files: ................................... 4
  85.          3.1 Files Contained In CODECNT1.EXE or CODECNT1.ZIP. .... 4
  86.          4.  Using Code Count: ................................... 4
  87.          4.1 Options.  ........................................... 4
  88.          4.2 File spec.  ......................................... 5
  89.          4.3 @list.  ............................................. 5
  90.          4.4 Code Count Output.  ................................. 5
  91.          4.5 Example use.  ....................................... 6
  92.          5.  User Support: ....................................... 6
  93.          Registration form: ...................................... 8
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                         Code Count For 'C' - Version 1.0
  136.  
  137.  
  138.  
  139.          1. Introduction:
  140.          ================
  141.  
  142.               Welcome to Code Count for 'C' an analysis and
  143.          documentation tool for 'C' programmers.
  144.  
  145.          1.1 What is Code Count.
  146.          -----------------------
  147.  
  148.               Code Count for 'C' is a tool which provides some useful
  149.          statistics for managing large programming effects in the 'C'
  150.          programming language.  Code Count scans 'C' source code files
  151.          and provides a breakdown of executable code versus non-
  152.          executable code.  This breakdown is in both a count of lines
  153.          and a count of characters.  Non-executable code is broken
  154.          down as comments, blanks, control characters (line feed,
  155.          carriage return, and end of file), and tabs.  Code Count also
  156.          provide a ratio of comments to executables.
  157.  
  158.               The Following is a sample printout from Code Count:
  159.  
  160.          File: SAMPLE.C
  161.                                         Lines         Characters
  162.          ==========================================================
  163.          | Total                  |         50    |       1981    |
  164.          |========================================================|
  165.          | Executable + mixed     |         36    |        793    |
  166.          |--------------------------------------------------------|
  167.          | Comment    + mixed     |         15    |        429    |
  168.          |--------------------------------------------------------|
  169.          | Blank                  |          3    |        660    |
  170.          |--------------------------------------------------------|
  171.          | Mixed lines (C. & E.)  |          4    |               |
  172.          |--------------------------------------------------------|
  173.          | LF+CR+EOF characters   |               |         99    |
  174.          |--------------------------------------------------------|
  175.          | Tab characters         |               |          0    |
  176.          |========================================================|
  177.          | Ratio       (C. : E.)  |     1:2.4     |     1:1.8     |
  178.          ==========================================================
  179.  
  180.                The obvious use of Code Count is to provide a final
  181.          tally at the end of a programming project, be it total lines,
  182.          executable lines, or what ever.  Being able to equate lines
  183.          of code to the effort expended will prove useful for
  184.          estimating or bidding your next job.
  185.  
  186.               You will also find that Code Count is an excellent tool
  187.          for keeping track of your programmers for a project that is
  188.          in progress.  By having your programming staff turn in their
  189.          source code every few days you can quickly see the amount of
  190.          work that has been accomplished since your last check.  Keep
  191.          in mind that lines of code are not necessarily a good
  192.          indicator of progress, but these numbers can alert you to
  193.  
  194.  
  195.          Copright (C) 1990 Enterprise Software                   page 1
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                         Code Count For 'C' - Version 1.0
  202.  
  203.  
  204.  
  205.          problems that need further investigation.
  206.               One of the biggest problems in a software development
  207.          team is proper documentation.  Documentation (of code) is
  208.          often left as a task to be done after the system is up and
  209.          running.  This can prove to be a fatal mistake, particularly
  210.          on a large project where the exact operation of code written
  211.          months previously is all but forgotten.  Code Counts ratios
  212.          of comments to executables can help you spot those
  213.          programmers that are leaving the documentation out.  A quick
  214.          look at the statistics produced by Code Count will even
  215.          indicate when the comments are heavily filled with blank
  216.          space.
  217.  
  218.          2. The Shareware Concept:
  219.          =========================
  220.  
  221.               Code Count is being distributed under the Shareware
  222.          concept.  If you are not familiar with the Shareware concept,
  223.          it is a method of distributing and selling high quality
  224.          computer software at prices far less then you would have to
  225.          pay for similar products in a retail software store.  The
  226.          cost to you is low because the cost of distribution and
  227.          marketing is reduced for the developer.  One of the most
  228.          attractive features about Shareware is that you may try the
  229.          product before you buy the product.  Code Count for instance
  230.          has a 30 day trial period before you are requested to
  231.          register or discontinue use.
  232.  
  233.               Shareware is distributed primarily through national and
  234.          local networks of electronic bulletin boards.  The only cost
  235.          to you to try a Shareware product is the online time charged
  236.          while downloading the software.  Other ways of obtaining
  237.          Shareware products are through the many mail order services
  238.          who will send you the programs for a handling charge. Also
  239.          computer user groups often maintain a library of the best
  240.          Shareware for their members. You may also buy Shareware
  241.          products from the author's directly.
  242.  
  243.               Code Count's distribution is increased with your help.
  244.          You are encouraged to share the program with friends and
  245.          co-workers.  It is only natural to want to share an
  246.          especially good find with your friend.  If you have access to
  247.          a local electronic bulletin board that does not already have
  248.          Code Count on it most systems operators will credit you with
  249.          additional connect time for uploading new programs.  As you
  250.          can see helping to distribute Code Count can be beneficial to
  251.          you as well as to me.  The consideration that Enterprise
  252.          Software asks is that when distributing Code Count please
  253.          distribute all files in their original form.  Please do not
  254.          delete, add or modify any files in any way.
  255.  
  256.          2.1 Why Register Code Count ?
  257.          -----------------------------
  258.  
  259.  
  260.  
  261.          Copright (C) 1990 Enterprise Software                   page 2
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                         Code Count For 'C' - Version 1.0
  268.  
  269.  
  270.  
  271.               By registering Code Count you derive both seen and
  272.          unseen benefits.  The unseen benefits are that you support
  273.          the Shareware concept and insure its continued use for
  274.          software distribution.   More directly you support the effort
  275.          put forth on Code Count and encourage the continued
  276.          enhancement of a product that you already like.
  277.  
  278.               The seen benefits are your contact with Enterprise
  279.          Software.  As a registered user you will be notified when
  280.          there are new releases of Code Count.  Registered users are
  281.          welcome to contact Enterprise Software for technical support.
  282.          Unlike many large software producers Enterprise Software
  283.          welcomes your comments and will even attempt to provide
  284.          custom features if so requested.
  285.  
  286.          2.2 License.
  287.          ------------
  288.  
  289.               You are granted a limited licence to use and examine
  290.          Code Count on a 30 day trial basis to determine if Code Count
  291.          is suitable for your needs.  If you find Code Count useful
  292.          and continue to use it on a regular basis, you should
  293.          complete and return the registration form along with the
  294.          indicated license/registration fee to Enterprise Software.
  295.  
  296.               Registration of a single user copy entitles you to use
  297.          Code Count for your personal or business use.  Use is however
  298.          restricted to one (single user) Personal Computer at a time.
  299.          You are granted permission to install Code Count on multiple
  300.          machines if you can guarantee that the software will not be
  301.          used on multiple machines simultaneously.
  302.  
  303.               Single copies of Code Count may be installed on multiple
  304.          machines or accessed by multiple users, if and only if the
  305.          proper multiple use license has been purchased.  Use and or
  306.          installation will be restricted to the quantities specified
  307.          in your specific license.
  308.  
  309.          2.3 Warranty.
  310.          -------------
  311.  
  312.               CODE COUNT AND ALL ACCOMPANYING MATERIALS ARE PROVIDED
  313.          "AS IS" WITHOUT WARRANTY OF ANY KIND.  YOU AS THE USER ASSUME
  314.          ALL RISKS FOR USE OF THIS PRODUCT.  ENTERPRISE SOFTWARE WILL
  315.          IN NO EVENT BE HELD LIABLE FOR ANY DAMAGES INCURRED BY USING
  316.          THIS PRODUCT, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS
  317.          OF BUSINESS PROFITS, LOSS OF SAVINGS, LOSS OR DAMAGE OF
  318.          MACHINERY AND/OR INFORMATION.
  319.  
  320.          BY USING CODE COUNT, YOU AGREE TO THE ABOVE CONDITIONS.
  321.  
  322.          2.4 Registration.
  323.          -----------------
  324.  
  325.  
  326.  
  327.          Copright (C) 1990 Enterprise Software                   page 3
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                         Code Count For 'C' - Version 1.0
  334.  
  335.  
  336.  
  337.               You may become a registered user of Code Count for $10.
  338.          Upon receipt of your registration fee you will be sent the
  339.          latest release of Code Count.  You will also receive a
  340.          personal serial number which will allow you to contact
  341.          Enterprise Software for technical support and allow you to
  342.          purchase upgrades when they are released.
  343.  
  344.               Businesses and other large organizations that would
  345.          like to use Code Count on multiple installations or with
  346.          multiple user access may contact Enterprise Software to
  347.          negotiate a site-license.  Site licenses will provide a
  348.          considerable saving over the purchase of multiple single user
  349.          copies.
  350.  
  351.  
  352.          3. Code Count Files:
  353.          ====================
  354.  
  355.               The following subsection lists the files that you should
  356.          have on your distribution disk.
  357.  
  358.               Code Count will be distributed in a compressed format.
  359.          The file that you receive will depend on the source that you
  360.          obtained Code Count from.  If you received Code Count
  361.          directly from Enterprise Software you will have the file
  362.          CODECNT1.EXE on your distribution disk.  This is a self
  363.          extracting archive file which will produce all the files
  364.          needed for Code Count when run.  If you received Code Count
  365.          from a bulletin board system you will probably have the file
  366.          CODECNT1.ZIP.  This is an archived file and requires the
  367.          proper decompression program to be used.  The bulletin board
  368.          that you received it from should have the proper
  369.          decompression program.
  370.  
  371.          3.1 Files Contained In CODECNT1.EXE or CODECNT1.ZIP.
  372.          ----------------------------------------------------
  373.  
  374.               C-CNT.EXE      - The Code Count program.
  375.               C-CNT.DOC      - The Code Count Documentation file
  376.               REGISTER.FRM   - Registration form
  377.  
  378.          4. Using Code Count:
  379.          ===================
  380.  
  381.               The syntax for using Code Count is as follows:
  382.  
  383.          C-CNT [option(s)...] [@list or file spec(s)...]
  384.  
  385.          4.1 Options.
  386.          ------------
  387.  
  388.               There are three options that may be used with Code
  389.          Count.  The options must appear before the list or any file
  390.          specs.  Options must be separated from one another by a space
  391.  
  392.  
  393.          Copright (C) 1990 Enterprise Software                   page 4
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                         Code Count For 'C' - Version 1.0
  400.  
  401.  
  402.  
  403.          and immediately preceded by either a dash (-) or a slash (/).
  404.  
  405.               The options are as follows:
  406.  
  407.          -H = displays the help information.
  408.  
  409.          -M = causes Code Count to look for the Microsoft C 5.1 non
  410.               standard double slash (//) comment.
  411.  
  412.          -N = causes Code Count to use standard ASCII characters in
  413.               its output.  By default Code Count will use the extended
  414.               graphics characters (which some printers do not print
  415.               correctly).
  416.  
  417.  
  418.          4.2 File spec.
  419.          --------------
  420.  
  421.               File spec. is an abbreviation for file specification.
  422.          This is simply the name of the file that Code Count is to
  423.          scan.  File specs. may have a full path and drive designator.
  424.          Wild cards (*,?) may also be used.  You may type as many file
  425.          specs. as will fit on the command line (DOS limit 127
  426.          characters).  Multiple file specs. must be separated by a
  427.          space.
  428.  
  429.  
  430.          4.3 @list.
  431.          ----------
  432.  
  433.               If you cannot fit all of your file specs. on the command
  434.          line you may place them in a list file.  An ampersand (@) on
  435.          the command line tells Code Count that the name immediately
  436.          following it is a list file.  Code Count will read the file
  437.          specs. in the list file and scan each file in it.
  438.  
  439.               A list file is an ASCII file with one file spec. per
  440.          line.  File specs may have a full path and drive designator
  441.          and may use wild cards (*,?).
  442.  
  443.               List files are very useful for checking the statistics
  444.          for all the files that make up an executable program.  It is
  445.          also useful to keep separate list files for individual
  446.          programmers.  That way when multiple programmers have been
  447.          working on a single executable you will only get the
  448.          statistics on the parts that one programmer worked on.
  449.  
  450.               You cannot mix the use of file specs. and a list file.
  451.          Use either one or the other.
  452.  
  453.          4.4 Code Count Output.
  454.          ----------------------
  455.  
  456.               Code Count produces a table for each file specified.  If
  457.  
  458.  
  459.          Copright (C) 1990 Enterprise Software                   page 5
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                         Code Count For 'C' - Version 1.0
  466.  
  467.  
  468.  
  469.          you have used multiple file specs or wild cards, Code Count
  470.          will also produce a summary table.
  471.  
  472.               Output from Code Count may be redirected with the DOS
  473.          redirection symbol (>) to a file or printer.
  474.  
  475.          4.5 Example use.
  476.          ----------------
  477.  
  478.               C-CNT -N tmenu.c sound.c tmenu.h > prn
  479.  
  480.               this would scan the files "tmenu.c", "sound.c" and
  481.          "tmenu.h".  The output would be sent to the PRN device (the
  482.          printer).  Since my printer uses the Epson printer character
  483.          set -N turns of the use of the ASCII graphic characters.
  484.  
  485.               C-CNT -M \msc\porject\*.c \msc\project\*.h > out.txt
  486.  
  487.               This would scan all of the files in the \msc\project
  488.          directory that have an extension of .c or .h.  Since the code
  489.          was written for Microsoft C version 5.1 the -M option is used
  490.          to allow the "//" comment delimiter.  The output will be
  491.          redirected to a file called out.txt.
  492.  
  493.               Now let's make a list file and call it tmenu.lst.  The
  494.          list would look like this:
  495.  
  496.               Tmenu.c
  497.               Sound.c
  498.               Message.c
  499.               Help.c
  500.               mouse.inc
  501.               tmenu.h
  502.  
  503.          You would use this list file like this:
  504.  
  505.               C-CNT @tmenu.lst > tmenu.cnt
  506.  
  507.               This example uses the list file tmenu.lst and scans each
  508.          file named in the list.  The output is redirected to the file
  509.          tmenu.cnt.
  510.  
  511.          5. User Support:
  512.          ================
  513.  
  514.               For user support on Code Count for 'C' call Enterprise
  515.          Software at (703) 335-2781.  Calls are welcome 7 days a week.
  516.          You may speak directly to Scott Ward on weekends and weekday
  517.          evenings.  For weekday day time calls you may leave a message
  518.          and your calls will be returned.
  519.  
  520.               You may also contact Enterprise Software through
  521.          Easyplex on Compuserve.  Enterprise Software's Compuserve ID
  522.          # is 71041,3714.
  523.  
  524.  
  525.          Copright (C) 1990 Enterprise Software                   page 6
  526.  
  527.  
  528.  
  529.  
  530.  
  531.                         Code Count For 'C' - Version 1.0
  532.  
  533.  
  534.  
  535.  
  536.               Support number: (703) 335-2781
  537.  
  538.                             day time     even (after 7pm)
  539.                        ==================================
  540.               weekdays | leave message  |  in person    |
  541.                        ----------------------------------
  542.               weekends | in person      |  in person    |
  543.                        ----------------------------------
  544.  
  545.               Compuserve ID #  71041,3714
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.          Copright (C) 1990 Enterprise Software                   page 7
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                         Code Count For 'C' - Version 1.0
  598.  
  599.  
  600.  
  601.          Registration form:
  602.          ------------------
  603.  
  604.               To become a registered user of Code Count, fill out the
  605.          information below and mail this form along with your
  606.          licensing fee to Enterprise Software.
  607.  
  608.          Name: _____________________________________________________
  609.  
  610.          Title: ____________________________________________________
  611.  
  612.          Company: __________________________________________________
  613.  
  614.          Address: __________________________________________________
  615.  
  616.                   __________________________________________________
  617.  
  618.          City: _____________________ State: _____ Zip: _____________
  619.  
  620.          Phone Work:(___) ___ - _____  Home:(___) ___ - ____
  621.  
  622.          I the under signed  agree to adhere to the licensing terms
  623.          for the use of Code Count for 'C' Version 1.0.  I further
  624.          agree to the disclaimer of all warranties and the
  625.          restrictions on copying Code Count.
  626.  
  627.          ___________________________________   ___________________
  628.                      SIGNED                            DATE
  629.  
  630.          The latest versions of Code Count will be sent to you on a 5
  631.          1/4"  disk.  Virginia residents please include 5% sales tax.
  632.          For a multi user and/or multiple copy license contact
  633.          Enterprise Software before mailing this form.
  634.  
  635.          +---------------------------------------------------+
  636.          | Description        | Cost per | Quantity | Total  |
  637.          |                    |   copy   |          | Cost   |
  638.          +--------------------+----------+----------+--------+
  639.          | Code Count Package | $10.00   X          =        |
  640.          +--------------------+----------+----------+--------+
  641.          |   Virginia residents add 5% sales tax    |        |
  642.          +------------------------------------------+--------+
  643.                                             Total   |        |
  644.                                                     +--------+
  645.  
  646.                      Make check or money order payable to:
  647.                        Scott R. Ward, Enterprise Software
  648.  
  649.          Send all items to:
  650.  
  651.                               Enterprise Software
  652.                               7654 Quail Run Lane
  653.                                Manassas, VA 22110
  654.  
  655.  
  656.  
  657.          Copright (C) 1990 Enterprise Software                   page 8
  658.  
  659.  
  660.  
  661.